Platform Explorer / Nuxeo Platform 2023.8

Operation NuxeoDrive.GetChangeSummary (Nuxeo Drive: Get change summary)

Description

Get a summary of document changes in the synchronization roots of the currently authenticated user. Return the result as a JSON blob.
Operation id NuxeoDrive.GetChangeSummary
Category Services
Label Nuxeo Drive: Get change summary
Requires
Since

Parameters

Name Description Type Required Default value
lastSyncActiveRootDefinitions string no  
lowerBound Optional lower bound of the interval for which to get the changes. If not provided, the list of document changes will be emtpy, yet the summary will contain the upper bound of the scanned interval. If set to 0, the interval will start from the repository's initialization. long no -1 

Signature

Inputs void
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.drive.operations.NuxeoDriveGetChangeSummary
Contributing Component org.nuxeo.drive.operations.NuxeoDriveGetRootsOperation

JSON Definition

{
  "id" : "NuxeoDrive.GetChangeSummary",
  "label" : "Nuxeo Drive: Get change summary",
  "category" : "Services",
  "requires" : null,
  "description" : "Get a summary of document changes in the synchronization roots of the currently authenticated user. Return the result as a JSON blob.",
  "url" : "NuxeoDrive.GetChangeSummary",
  "signature" : [ "void", "blob" ],
  "params" : [ {
    "name" : "lastSyncActiveRootDefinitions",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "lowerBound",
    "description" : "Optional lower bound of the interval for which to get the changes. If not provided, the list of document changes will be emtpy, yet the summary will contain the upper bound of the scanned interval. If set to 0, the interval will start from the repository's initialization.",
    "type" : "long",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "-1" ]
  } ]
}